<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: perf/timed_function.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_c3b46db8887e8285e98d946e3c1c617e.html">perf</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">timed_function.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="timed__function_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="perf__fwd_8hpp.html">flow/perf/perf_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="clock__type__fwd_8hpp.html">flow/perf/clock_type_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="checkpt__timer_8hpp.html">flow/perf/checkpt_timer.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1perf.html">flow::perf</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Accumulator, <span class="keyword">typename</span> Func&gt;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespaceflow_1_1perf.html#a0dee22ec7bf250bbbf556a7e15c1f784">   32</a></span><span class="keyword">auto</span> <a class="code hl_function" href="namespaceflow_1_1perf.html#a0dee22ec7bf250bbbf556a7e15c1f784">timed_function</a>(<a class="code hl_enumeration" href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">Clock_type</a> clock_type, Accumulator* accumulator, Func&amp;&amp; function)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>  <span class="keywordflow">return</span> [clock_type, accumulator, function = std::move(function)](<span class="keyword">auto</span>&amp;&amp;... params) <span class="keyword">mutable</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>    <span class="keyword">const</span> <span class="keyword">auto</span> start = <a class="code hl_function" href="classflow_1_1perf_1_1Checkpointing__timer.html#a3b73f2812c2bf6a27ef2becc13859d73">Checkpointing_timer::now</a>(clock_type);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>    function(std::forward&lt;<span class="keyword">decltype</span>(params)&gt;(params)...);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>    <span class="comment">/* If Accumulator is atomic&lt;duration_rep_t&gt;: this is fetch_add() with memory ordering arg = strict.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment">     * @todo A non-strict-ordering-using API may be desirable. */</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>    *accumulator += (<a class="code hl_function" href="classflow_1_1perf_1_1Checkpointing__timer.html#a3b73f2812c2bf6a27ef2becc13859d73">Checkpointing_timer::now</a>(clock_type) - start).count();</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  };</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>}</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Accumulator, <span class="keyword">typename</span> Func&gt;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="namespaceflow_1_1perf.html#a58d2f7a7fca0c3cfd0a87ae560ce4926">   47</a></span><span class="keyword">auto</span> <a class="code hl_function" href="namespaceflow_1_1perf.html#a58d2f7a7fca0c3cfd0a87ae560ce4926">timed_function_nvr</a>(<a class="code hl_enumeration" href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">Clock_type</a> clock_type, Accumulator* accumulator, Func&amp;&amp; function)</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>{</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <span class="comment">// It&#39;s much like timed_function() -- just adding passing-through function() return value.  Comments kept light.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>  <span class="keywordflow">return</span> [clock_type, accumulator, function = std::move(function)](<span class="keyword">auto</span>&amp;&amp;... params) <span class="keyword">mutable</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>    <span class="keyword">const</span> <span class="keyword">auto</span> start = <a class="code hl_function" href="classflow_1_1perf_1_1Checkpointing__timer.html#a3b73f2812c2bf6a27ef2becc13859d73">Checkpointing_timer::now</a>(clock_type);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>    <span class="comment">// Copy elision should avoid copying the result here.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>    <span class="keyword">const</span> <span class="keyword">auto</span> result = function(std::forward&lt;<span class="keyword">decltype</span>(params)&gt;(params)...);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    *accumulator += (<a class="code hl_function" href="classflow_1_1perf_1_1Checkpointing__timer.html#a3b73f2812c2bf6a27ef2becc13859d73">Checkpointing_timer::now</a>(clock_type) - start).count();</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    <span class="comment">/* I (ygoldfel) *think* this will be copy/move-elided... but not sure.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">     * If yes, then this is good.  If not, then should add std::move(), to make sure it doesn&#39;t get copied (ugh).</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">     * @todo Look into it, maybe experimentally! */</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    <span class="keywordflow">return</span> result;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  };</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>}</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>} <span class="comment">// namespace flow::perf</span></div>
<div class="ttc" id="acheckpt__timer_8hpp_html"><div class="ttname"><a href="checkpt__timer_8hpp.html">checkpt_timer.hpp</a></div></div>
<div class="ttc" id="aclassflow_1_1perf_1_1Checkpointing__timer_html_a3b73f2812c2bf6a27ef2becc13859d73"><div class="ttname"><a href="classflow_1_1perf_1_1Checkpointing__timer.html#a3b73f2812c2bf6a27ef2becc13859d73">flow::perf::Checkpointing_timer::now</a></div><div class="ttdeci">Time_pt_set now() const</div><div class="ttdoc">Sample all currently enabled Clock_types' clocks and return those values, each of which is a time sta...</div><div class="ttdef"><b>Definition:</b> <a href="checkpt__timer_8cpp_source.html#l00241">checkpt_timer.cpp:241</a></div></div>
<div class="ttc" id="aclock__type__fwd_8hpp_html"><div class="ttname"><a href="clock__type__fwd_8hpp.html">clock_type_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html"><div class="ttname"><a href="namespaceflow_1_1perf.html">flow::perf</a></div><div class="ttdoc">Flow module containing tools for profiling and optimization.</div><div class="ttdef"><b>Definition:</b> <a href="checkpt__timer_8cpp_source.html#l00024">checkpt_timer.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_a0dee22ec7bf250bbbf556a7e15c1f784"><div class="ttname"><a href="namespaceflow_1_1perf.html#a0dee22ec7bf250bbbf556a7e15c1f784">flow::perf::timed_function</a></div><div class="ttdeci">auto timed_function(Clock_type clock_type, Accumulator *accumulator, Func &amp;&amp;function)</div><div class="ttdoc">Constructs a closure that times and executes void-returning function(), adding the elapsed time with ...</div><div class="ttdef"><b>Definition:</b> <a href="timed__function_8hpp_source.html#l00032">timed_function.hpp:32</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_a58d2f7a7fca0c3cfd0a87ae560ce4926"><div class="ttname"><a href="namespaceflow_1_1perf.html#a58d2f7a7fca0c3cfd0a87ae560ce4926">flow::perf::timed_function_nvr</a></div><div class="ttdeci">auto timed_function_nvr(Clock_type clock_type, Accumulator *accumulator, Func &amp;&amp;function)</div><div class="ttdoc">Constructs a closure that times and executes non-void-returning function(), adding the elapsed time w...</div><div class="ttdef"><b>Definition:</b> <a href="timed__function_8hpp_source.html#l00047">timed_function.hpp:47</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_ad61fb186191e4bb824d14601d11a2eb0"><div class="ttname"><a href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">flow::perf::Clock_type</a></div><div class="ttdeci">Clock_type</div><div class="ttdoc">Clock types supported by flow::perf module facilities, perf::Checkpointing_timer in particular.</div><div class="ttdef"><b>Definition:</b> <a href="clock__type__fwd_8hpp_source.html#l00066">clock_type_fwd.hpp:67</a></div></div>
<div class="ttc" id="aperf__fwd_8hpp_html"><div class="ttname"><a href="perf__fwd_8hpp.html">perf_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
